home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / quiktp31.zip / QUIKTOP.DOC < prev    next >
Text File  |  1991-10-30  |  9KB  |  292 lines
  1.  
  2. ------------------------------------------------------------------------------
  3.                                QuikTop v3.1
  4.  
  5.                   QuickBBS Top Users Bulletin Generator
  6.  
  7.                  Copyright (C) 1990-91  Foxtrot Software
  8.                            All Rights Reserved.
  9.  
  10.   This is a shareware program, this program is not to be sold or modified
  11. in any way.  You are free to copy and distribute QuikTop as long as:
  12.  
  13.   a.  No fee is charged for use of the program or the documentation.
  14.       A fee may be charged for copying or distibution of this software
  15.       and documentation for others not to exceed US $10.00.
  16.  
  17.   b.  It is not modified in any way.
  18.  
  19.   c.  This software and documentation or either is not used commercially.
  20.  
  21.   d.  You distribute this software along with all documentation and
  22.       registration forms unmodified.
  23.  
  24.   The Author hereby disclaims all warranties relating to this software,
  25. whether expressed or implied, including without limitation any implied
  26. warranties of merchantability or fitness for a particular purpose.  The
  27. author will not be liable for any special, incidental, consequenctial,
  28. indirect or simular damages due to loss of data or any other reason.  The
  29. user of this software bears all risk as to the quality  and performance
  30. of this software.
  31.  
  32. -------------------Now that we have that out of the way-----------------------
  33.  
  34.   If you have any comments or suggestions for improvement of this software,
  35. you can contact me at Info-Center BBS, data: (914)567-1814, 24 hours a
  36. day or leave Net-Mail @Fidonet 1:272/26, @Magnet 100:900/39.
  37.  
  38.   If you like this software, and decide to keep it on your system, then
  39. please register your copy.  Registration is US $8.00.  Please help support
  40. the shareware concept and development of even more quality utilities.
  41.  
  42. Thank you for your support.
  43.  
  44. ------------------------------------------------------------------------------
  45.  
  46. 1. Introduction.
  47.  
  48.    QuikTop is a utility that will allow the Sysop of a QuickBBS system to
  49. produce a TOP Users Bulletin that conatins the TOP Callers, TOP
  50. Downloaders and TOP Uploaders by name and how many times they called,
  51. bytes downloaded and bytes Uploaded on your system.  
  52.  
  53.   QuikTop uses the environment variable QUICK to find the QuickCfg.Dat
  54. file.  If the environment variable is not set on your system, then
  55. QuickTop must be run in the same directory where your system files are
  56. located.
  57.  
  58.   You can set the variable by using the DOS Command SET QUICK=C:\QUICKBBS
  59. in your autoexec.bat startup file.
  60.  
  61.   The bulletin is usually placed in same directory as all other text files
  62. so a menu option can be built to allow a user to view the Bulletin.
  63.  
  64.    This version of QuikTop is for use with QuickBBS V 2.75 and later
  65.    releases.
  66.  
  67.  
  68.  
  69. 2.  Setup.
  70.  
  71.     The following outlines what commands to in the QuikTop.CTL control
  72.     file and COLORS available to adjust to your liking.
  73.  
  74.     a.  An Editor that will create text files, such as EDLIN, GALAXY,
  75.         or any Editor that will allow CR/LF combinations at the end of each
  76.         line has to be used.  Create the QuikTop.CTL file in your QUICKBBS
  77.         BBS directory where your Users.BBS file or if the QUICK environment
  78.         variable is set, the directory you will be running QuikTop from.
  79.         Enter the following information:
  80.  
  81. ;
  82. ; Path - Full pathname of where you want the bulletin put.  No extension
  83. ;        is placed on this pathname.  If this command isn't present, then
  84. ;        RaTop will assume BULLET01 only as the filename and place the
  85. ;        bulletins in your current directory.
  86. ;
  87. Path        D:\QuickBBS\Txtfiles\Bullet01
  88. ;
  89. ; Title - The Title you wish to have at the heading of the bulletin.
  90. ;         This can be anything you desire as long as it is 70 characters
  91. ;         or less.  If this command isn't present, then QuikTop will assume:
  92. ;
  93. Title       Info-Center BBS * Top BBS Users Report
  94. ;
  95. ; Frame - This is the color you want the frame of the bulletin to be.
  96. ;
  97. Frame       3
  98. ;
  99. ; Title1 - This is the color you want the Title above to be.
  100. ;
  101. Title1      15
  102. ;
  103. ; Title2 - This is the color you want the Bulletin Heading to be.
  104. ;          The bulletin heading is:
  105. ;          'C A L L E R S   D O W N L O A D E R S   U L O A D E R S'
  106. ;
  107. Title2      10
  108. ;
  109. ; Users  - This is the color you want the users names to be.
  110. ;
  111. Users       14
  112. ;
  113. ; Background - This is the color you want the bulletin background to be.
  114. ;
  115. Background  0
  116. ;
  117. ; Security - The lowest security level a user has to have before being included 
  118. ;            in the bulletin.  Max is 32000.
  119. ;
  120. SecurityLvl 5
  121. ;
  122. ; SecFlags - This works exactly like the flags work for QuickBBS.
  123. ;            
  124. SecFlags    -------- -------- -------- --------
  125. ;
  126.  
  127.  
  128.     b.   Available Colors Codes:
  129.  
  130.                ________
  131.        0  Black         \
  132.        1  Blue           \
  133.        2  Green           \  BackGround or
  134.        3  Cyan             ---------------
  135.        4  Red             /  ForeGround
  136.        5  Magenta        /
  137.        6  Brown         /
  138.        7  LightGray ___/
  139.                 _______
  140.        8  Gray         \
  141.        9  LightBlue     \
  142.        10 LightGreen     \  Foreground Only
  143.        11 LightCyan       ------------------
  144.        12 LightRed       /
  145.        13 LightMagenta  /
  146.        14 Yellow       /
  147.        15 White ______/
  148.  
  149.  
  150.  
  151.     c.  How to run QuikTop:
  152.  
  153.         Usage:  QuikTop [-S] [{-U n}] [-?] [{-F CtlFile}]
  154.  
  155.         QuikTop can be executed with any or none of the following arguments:
  156.  
  157.         [-S]         -  will tell QuikTop to include the SysOp's name and
  158.                         number of Calls, Downloads and Uploads.  Default is not
  159.                         to include the SysOp in the Bulletin.
  160.  
  161.         [-U n]       -  will tell QuikTop how many Users you wish to include
  162.                         in the Bulletin.  Default is The Top 20 Users.
  163.                         Valid numbers are from 10 - 32000.
  164.  
  165.         [-?]         -  will tell QuikTop to display command line help.  If
  166.                         this argument is to be used, then it must be the only
  167.                         one used on the command line to recieve help.
  168.  
  169.     *   [-F CtlFile] -  will tell QuikTop to use an alternate Control file
  170.                         to process.  This would allow you to create numerous
  171.                         bulletins using different security/flags settings.
  172.                         *  Available to Registered Copies Only.
  173.  
  174.  
  175.     d.  All that is needed now is, you to make sure that you have
  176.         QuikTop.Exe and QuikTop.CTL in the same directory and then execute
  177.         it in that directory.  QuikTop.EXE defaults to USERS.BBS and is
  178.         not configurable by you.
  179.  
  180.  
  181. 4.  Closing.
  182.  
  183.     I hope this little utility will help enhance your QuickBBS.
  184.     I had fun writing it anyway.
  185.  
  186.  
  187. Update History:
  188.  
  189.     12/31/89     -  First Release 1.0.
  190.  
  191.     01/04/89     -  An extra space was added to names even if it exceeded
  192.     v1.1            the column limit.
  193.  
  194.                  -  One more color added "LIGHTGRAY".  How did I forget
  195.                     this one?
  196.  
  197.                  -  Users Delete flag is now checked.  If set then
  198.                     User will not be processed.
  199.  
  200.                  -  All works files are deleted upon sucessful
  201.                     completion.
  202.  
  203.     01/05/89     -  Added command line parameters [-s] and
  204.     v2.0            [-u n] to allow more flexibility for the SysOp when
  205.                     generating the Bulletin.  Thanks to Paul Knox
  206.                     SysOp of Ft. Knox BBS (1:360/12) for all his input.
  207.  
  208.     08/08/90     -  Code Optimization.
  209.     v2.1
  210.  
  211.     08/30/90     -  Completly rewrite the search and sort logic.  Index
  212.     v3.0            files are now used to help speed up the process.
  213.  
  214.     10/30/91     -  I thought a sort speed up was in order.
  215.     v3.1         -  Added option -F to allow processing of an alternate
  216.                     Control file for building multiple bulletins.
  217.                  -  Added full user flag security support.
  218.  
  219.  
  220.                      
  221. Other quality software available from me for SysOps:
  222.  
  223. Magic Name     Description
  224.  
  225. RAFBSTAT       Creates a bulletin with stats on all your files areas for
  226.                Remote Access v 1.0.
  227.  
  228. QUIKTOP        Creates a Top Users bulletin for QuickBBS 2.75.
  229.  
  230. RATOP          Creates a Top Users bulletin for RA v1.01.
  231.  
  232. OPUSTOP        Creates a Top Users bulletin for OPUS CBCS 1.1x.
  233.  
  234.  
  235.  
  236. PROBLEMS:
  237.  
  238.    Please notify me immediately if you have any problems or
  239. suggestions about this program.  Enhancements are being incorporated
  240. all the time and your input is more vital to this process than you
  241. think.  You may write me, send Net-Mail or logon at the following address:
  242.  
  243. Byron Copeland (Sysop)               Info-Center BBS (formerly The
  244. 11 Y Street                              Foxtrot BBS, 1:360/11)
  245. New Windsor, NY 12553                (914) 567-1814 @Fidonet 1:272/26
  246.                                      24 hours, Every day!
  247.  
  248.  
  249.  
  250.                 Enjoy and thank you for your support.
  251.  
  252.  
  253.                               - End -
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.